Get a Security Role by ID

Returns the security role using its ID.

Method

/API2/access/getRoleById

  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin

Method Signature

Input Parameters

Name

roleId

Type

string

Description

The system role ID

Output Response

Successful Result Code

200

Response Type

RoleData

Description of Response Type

An object for defining which user is attached to a role.

Notes

Use this function with other functions for setting and getting roles and role related functions. Use the 'getRolesByName' method to retrieve role ID's